Vcenter NamespaceManagement Networks VsphereDVPGNetworkUpdateSpec

The Vcenter NamespaceManagement Networks VsphereDVPGNetworkUpdateSpec schema contains new configuration to update on an existing a vSphere DVPG-backed Namespaces Network object.

This schema was added in vSphere API 7.0.3.0.

JSON Example

{
    "portgroup": "string",
    "address_ranges": [
        {
            "address": "string",
            "count": 0
        }
    ],
    "gateway": "string",
    "subnet_mask": "string",
    "mode": "string"
}

string

portgroup

Optional

Identifier of the vSphere Distributed Portgroup backing the vSphere network object. If the network object is associated with a Namespace or is Vcenter NamespaceManagement Clusters WorkloadNetworksEnableSpec.supervisor_primary_workload_network, then modification to existing portgroup will result in the operation failing with a Vapi Std Errors ResourceInUse error.

This property was added in vSphere API 7.0.3.0.

If missing or null, the current value will be retained.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network.

array of Vcenter NamespaceManagement IPRange

address_ranges

Optional

Usable IP pools on this network. If the network object is associated with a Namespace or is Vcenter NamespaceManagement Clusters WorkloadNetworksEnableSpec.supervisor_primary_workload_network, then replacement of or modification to any existing range in this list will result in operation failing with a Vapi Std Errors ResourceInUse error. To add new address ranges to the list, existing address ranges have to be passed in without modifications.

This property was added in vSphere API 7.0.3.0.

If missing or null, the current value will be retained.

string

gateway

Optional

Gateway for the network. If the network object is associated with a Namespace or is Vcenter NamespaceManagement Clusters WorkloadNetworksEnableSpec.supervisor_primary_workload_network, then modification to existing gateway will result in the operation failing with a Vapi Std Errors ResourceInUse error.

This property was added in vSphere API 7.0.3.0.

If missing or null, the current value will be retained.

string

subnet_mask

Optional

Subnet mask of the network. If the network object is associated with a Namespace or is Vcenter NamespaceManagement Clusters WorkloadNetworksEnableSpec.supervisor_primary_workload_network, then modification to existing subnet mask will result in the operation failing with a Vapi Std Errors ResourceInUse error.

This property was added in vSphere API 7.0.3.0.

If missing or null, the current value will be retained.

string

mode

Optional

Assigns a mode to a network. A mode describes the intended use of the network.

Modes cannot be changed when a network is associated with a Namespace, a load balancer, or is the Vcenter NamespaceManagement Clusters WorkloadNetworksEnableSpec.supervisor_primary_workload_network.

For more information see: Vcenter NamespaceManagement Networks Mode.

This property was added in vSphere API 9.0.0.0.

If missing or null the current value will be retained.